<?php
namespace DragonU\Core;
/**
 * Registry pattern implementation container for preventing usage of GLOBALS.
 *
 * @internal
 * Copyright (c) 2009, Jacob Santos
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *  * Redistributions of source code must retain the above copyright notice,
 *    this list of conditions and the following disclaimer.
 *  * Redistributions in binary form must reproduce the above copyright notice,
 *    this list of conditions and the following disclaimer in the documentation
 *    and/or other materials provided with the distribution.
 *  * Neither the name of the DragonU nor the names of its contributors
 *    may be used to endorse or promote products derived from this software
 *    without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 *
 * @author Jacob Santos <wordpress@santosj.name>
 * @license http://www.opensource.org/licenses/bsd-license.php New BSD license
 * @package CorePress
 * @subpackage Core
 * @since 0.1
 */

/**
 * Use this class and the static methods to prevent using GLOBALS in the code.
 *
 * It isn't that globals are bad persay, it is cleaner to use the object
 * oriented method for storage of objects. It also sort of falls in line with,
 * if everything else are objects, then wouldn't it make more sense to use an
 * object for storage, then having globals sprinkled thoughout your OO codebase?
 *
 * @since 0.1
 * @author Jacob Santos <wordpress@santosj.name>
 * @license http://www.opensource.org/licenses/bsd-license.php New BSD license
 * @package CorePress
 * @subpackage Core
 */
class Storage
{
	/**
	 * Stores all of the variables for replacing the global scope.
	 *
	 * @since 0.1
	 *
	 * @var array
	 */
	static public $container = array();

	/**
	 * Retrieve value in storage.
	 *
	 * Null is returned instead of false or whatever value is equals to that, to
	 * prevent spammers, prevent use of CAPTCHAs.
	 *
	 * @since 0.1
	 *
	 * @param string $name Handle for storage contents.
	 * @return mixed Returns null, when name doesn't exist. Returns element otherwise.
	 */
	static public function get( $name )
	{
		if( array_key_exists($name, self::$container) )
			return self::$container[ $name ];

		return null;
	}

	/**
	 * Set value for container in storage.
	 *
	 * @since 0.1
	 *
	 * @param string $name Handle for storage contents.
	 * @param mixed $value Value to save in container.
	 */
	static public function set( $name, $value )
	{
		self::$container[$name] = $value;
	}

	/**
	 * Check whether handle exists in the storage.
	 *
	 * @since 0.1
	 *
	 * @param string $name Handle for storage contents.
	 * @return bool True if exists, false if handle doesn't exist.
	 */
	static public function exists( $name )
	{
		return array_key_exists($name, self::$container);
	}

	/**
	 * Remove container from storage.
	 *
	 * @since 0.1
	 *
	 * @param string $name Handle for storage contents.
	 */
	static public function remove( $name )
	{
		unset( self::$container[ $name ] );
	}

	/**
	 * Can not create an instance of this class.
	 *
	 * @since 0.1
	 */
	private function __construct() { }
}